Introduction

Commvault is a highly demanding data protection solution offered for medium and large enterprises. It has an customizable online user interface to handle our disaster recovery and data protection efforts. Through default streamlined procedures and configuration values, it reduces the time of regular data recovery and protection tasks. Through the command center of Commvault, we can identify the content that we want to secure and begin and control the restores and backups.

Key Benefits

• Provides resource visibility to the administrator to view and manage resources available (Ex: Clients) under different resource types.
• Publishes relationships between resources to have a topological view and ease of maintenance.
• Provides metrics related to Job Performance and Status.
• Concern alerts will be generated for each metric to notify the administrator regarding the issue with the resource.

Supported Target Version

• 11 SP 32.35

Prerequisites

• OpsRamp Classic Gateway (Linux) 15.0.0 or above.
• OpsRamp NextGen Gateway 15.0.0 or above.
  Note: OpsRamp recommends using the latest Gateway version for full coverage of recent bug fixes, enhancements, etc.
• To access commvault Rest API credentials with master permissions are required.

Resource Hierarchy

If you select CommCell Type as CommCell, the following is the resource hierarchy.

CommCell
      → CommServer

If you select CommCell Type as CommCell - Client, the following is the resource hierarchy.

CommCell - Client
      → CommServer
            → Client

Supported Metrics

The following tabs represent the Native types of Commvault

Default Monitoring Configurations

Commvault has default Global Device Management Policies, Global Templates, Global Monitors and Global Metrics in OpsRamp. You can customize these default monitoring configurations as per your business requirement by cloning respective Global Templates and Global Device Management Policies. It is recommended to clone them before installing the application to avoid noise alerts and data.

1. Default Global Device Management Policies

   You can find the Device Management Policy for each Native Type at Setup > Resources > Device Management Policies. Search with suggested names in global scope:

   {appName nativeType - version}

   Ex: commvault Client - 1 (i.e, appName = commvault, nativeType = Client, version = 1)

2. Default Global Templates

   You can find the Global Templates for each Native Type at Setup > Monitoring > Templates. Search with suggested names in global scope. Each template adheres to the following naming convention:

   {appName nativeType 'Template' - version}

   Ex: commvault Client Template - 1 (i.e, appName = commvault, nativeType = Client, version = 1)

3. Default Global Monitors

   You can find the Global Monitors for each Native Type at Setup > Monitoring > Monitors. Search with suggested names in global scope. Each Monitors adheres to the following naming convention:

   {monitorKey appName nativeType - version}

   Ex: Client Monitor commvault Client 1(i.e, monitorKey = Client , appName = commvault, nativeType = Client , version = 1)

Configure and Install the Commvault Integration

1. To select your client, navigate to All Clients, and click the Client/Partner dropdown menu.
   Note: You may either type your client’s name in the search bar or select your client from the list.
2. Navigate to Setup > Account. The Account Details screen is displayed.
3. Click Integrations. The Installed Integrations screen is displayed with all the installed applications.
   Note: If you do not have any installed applications, you will be navigated to the Available Integrations and Apps page with all the available applications along with the newly created application with the version.
4. Click + ADD on the Installed Integrations page.
   Note: Search for the integration either by entering the name of the integration in the search bar or by selecting the category of the integration from the All Categories dropdown list.
5. Click ADD in the Commvault application.
6. In the Configuration screen, click + ADD. The Add Configuration screen appears.
7. Enter the following BASIC INFORMATION:

8. CUSTOM ATTRIBUTES: Custom attributes are the user-defined data fields or properties that can be added to the preexisting attributes to configure the integration.

Note: The custom attribute that you add here will be assigned to all the resources that are created by the integration. You can add a maximum of five custom attributes (key and value pair).

9. In the RESOURCE TYPE section, select:
   • ALL: All the existing and future resources will be discovered.
   • SELECT: You can select one or multiple resources to be discovered.
10. In the DISCOVERY SCHEDULE section, select recurrence pattern to add one of the following patterns:
    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
11. Click ADD.

Now the configuration is saved and displayed on the configurations page after you save it.
Note: From the same page, you may Edit and Remove the created configuration.
12. Under the ADVANCED SETTINGS, Select the Bypass Resource Reconciliation option, if you wish to bypass resource reconciliation when encountering the same resources discovered by multiple applications.
Note: If two different applications provide identical discovery attributes, two separate resources will be generated with those respective attributes from the individual discoveries.
13. Click NEXT.
14. (Optional) Click +ADD to create a new collector. You can either use the pre-populated name or give the name to your collector.
15. Select an existing registered profile.

16. Click FINISH.
    The integration is installed and displayed on the INSTALLED INTEGRATION page. Use the search field to find the installed integration.

Modify the Configuration

• See Modify an Installed Integration or Application article.

  Note: Select Commvault.

View the Commvault Details

To discover resources for Commvault Storage:

1. Navigate to Infrastructure > Search > Backup and Recovery > Commvault. The Commvault page is displayed.
2. Select the application on the Commvault page
3. The RESOURCE page appears from the right.
4. Click the ellipsis (…) on the top right and select View Details.

5. Navigate to the Attributes tab to view the discovery details.

View resource metrics

To confirm Commvault monitoring, review the following:

• Metric graphs: A graph is plotted for each metric that is enabled in the configuration.
• Alerts: Alerts are generated for metrics that are configured as defined for integration.

6. Click the Metrics tab to view the metric details for Commvault.

Supported Alert Custom Macros

Customize the alert subject and description with the following macros so that it can generate alerts accordingly.
Supported macros keys:

Resource Filter Input keys

Commvault application Resources are filtered and discovered based on below keys.

Note: You can filter the resources with the discoverable keys only.

Risks, Limitations and Assumptions

• The integration can manage critical/recovery failure alerts for the following two scenarios when the user activates App Failure Notifications in the settings:
  • Connectivity Exception
  • Authentication Exception
• Commuvault will not send any duplicate/repeat failure alert notification until the already existing critical alert is recovered.
• Using metrics for monitoring the resources and generating alerts when the threshold values are breached.
• Commvault cannot control monitoring pause/resume actions based on above alerts.
• Commvault is not compatible with cluster gateway.
• Displaying job information as metrics on each client. So the instance of job related metrics is in the format appTypeName_instanceName_jobId.
• In commvault if a job is completed or failed due to any reason then for the next scheduled time a new job will be created with new jobid, hence the generated alert from OpsRamp will not be healed automatically.
• The Template Applied Time will only be displayed if the collector profile (Classic and NextGen Gateway) is version 18.1.0 or higher.
• Port 8080 should be open for rest API execution.

Version History